fix(bump)!: only add version files and staged changes#1261
fix(bump)!: only add version files and staged changes#1261marcusalstrom wants to merge 4 commits intocommitizen-tools:v5from
Conversation
BREAKING CHANGE: VersionProvider has new method which will break any custom version provider
…version providers
marcusalstrom
requested review from
Lee-W,
noirbizarre and
woile
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## v5 #1261 +/- ##
=====================================
Coverage ? 97.64%
=====================================
Files ? 55
Lines ? 2594
Branches ? 0
=====================================
Hits ? 2533
Misses ? 61
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
As this is breaking change, I change the base branch to v4 |
| """ | ||
|
|
||
| @abstractmethod | ||
| def get_files(self) -> list[str]: |
There was a problem hiding this comment.
maybe renamed as version_files would be better?
Lee-W
added
pr-status: wait-for-modification
and removed
pr-status: wait-for-review
labels
|
In general, I like this idea. @woile @noirbizarre would love to know your thought 🙂 |
|
No unexpected extra file in release, I like this idea too, but it should include the changelog too if the option is set. If it was possible to bump a dirty working copy, this is obviously a breaking change, and we should provide a way around this. Maybe a setting and param |
3 participants
Description
Bump will now only add and commit version files along with any already committed changes. Any unstaged changes will remain unstaged.
NOTE: BREAKING CHANGE, since we added a new abstract method to VersionProvider any custom version provider will break. (open to any suggestions on how to avoid this)
Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
Only version files and already staged changes will be committed on bump.
Steps to Test This Pull Request
Additional context
References issue #1194